home *** CD-ROM | disk | FTP | other *** search
/ AOL File Library: 9,300 to 9,399 / 9300.zip / AOLDLs / HTML & Web Tools (MAC) / CW_ V1.2.1 Cinnamon WebMstrSuite / CWMS_1.2.1.sit / Cinnamon WebMaster Suite 1.2.1 / Read Me Please! < prev    next >
Text File  |  1998-04-07  |  20KB  |  267 lines

  1.             Cinnamon WebMaster Suite
  2.                                                                                                         Version 1.2.1
  3.  
  4. ***** Please read this document thoroughly, but for a quick over- *****
  5. ***** view of changes and new features in this version, please see *****
  6. ***** the "Version History" section at the bottom.                              *****
  7.  
  8. Contents
  9.  
  10.     Introduction
  11.     What is Cinnamon WebMaster Suite?
  12.     How to use CWMS
  13.     Special Features
  14.     How much does Cinnamon WebMaster Suite cost?
  15.     About Cinnamon Computer Products
  16.     Licensing and Distribution Information
  17.     Future Additions
  18.     Compatibility
  19.     Known Problems & Issues
  20.     Version History
  21.     BugZappers Hall of Fame ** Recently New Section **
  22.     Legal Information
  23.  
  24. Introduction
  25.  
  26. Thank you for downloading Cinnamon WebMaster Suite! This is the first product of Cinnamon Soft, a division of Cinnamon Computer Products. Cinnamon WebMaster Suite (CWMS) will eventually turn into a full-fledged commercial product, but for now it was originally intended for my own use. I have decided to release it as shareware in the meantime, because it is already a fully-functional and very useful product.
  27.  
  28. What is Cinnamon WebMaster Suite?
  29.  
  30. CWMS is a straightforward, yet very useful and useable, HTML editor. It is the perfect solution for Mac OS-based Web Page Design. It is compact, yet full of features.
  31.  
  32. Cinnamon WebMaster Suite was created to fulfill a need. WYSIWYG web page programs such as Adobe Pagemill just simply don't do the job. If I was going to have to write my own HTML, I needed a good editor--one that did more than a regular word processor, one that specifically helped me write web pages. It was out of this need that I created CWMS. It has all the capabilities of a simple text editor, with many special features dealing with HTML. As you read about and use Cinnamon WebMaster Suite, you will begin to discover these wonderful features. They hide well, but always ready to spring into action!
  33.  
  34. How to use CWMS
  35.  
  36. Using Cinnamon WebMaster Suite is quite easy. Everything is standard Mac OS. To open the program, you can double-click its icon or the icon of a document created by CWMS.
  37.  
  38. The Apple Menu
  39. Ñ About Cinnamon WebMaster Suite
  40.     Displays information about CWMS
  41. Ñ About Cinnamon Soft
  42.     Displays information about CCP
  43.  
  44. The File Menu
  45. Ñ New
  46.     Creates a blank new document
  47. Ñ Open╔
  48.     Open an existing document (Usually an HTML document, but you can open any TEXT file)
  49. Ñ Close
  50.     Close the current document
  51. Ñ Save
  52.     Save the current document (If untitled, will automatically function as Save As╔)
  53. Ñ Save As╔
  54.     Saves the current document as a new document and switches to the new one
  55. Ñ Export╔
  56.     Saves the current document as a new document without switching to the new one
  57. Ñ Quit
  58.     Quits the program after closing all open documents
  59.  
  60. The Edit Menu
  61. Ñ Undo
  62.     Undo does not function in this version of CWMS (see Future Additions, below)
  63. Ñ Cut, Copy, Paste, Clear
  64.     The standard Mac OS clipboard commands
  65. Ñ Select All
  66.     Selects the entire document
  67. Ñ Insert Color
  68.     Using the Apple Color Picker, automatically formats and inserts the HTML color code
  69. Ñ Insert Current Date *** New in v1.2 ***
  70.     Betcha can't guess...
  71. Ñ Insert Current Time *** New in v1.2 ***
  72.     Another no-brainer...
  73. Ñ Colorize Text in Selection
  74.     Color-codes the tags & comments in the selected area of text
  75. Ñ Preferences
  76.     Preferences does not function in this version of CWMS (see Future Additions, below)
  77.  
  78. The Window Menu
  79.     Any open documents are displayed under this menu, in alphabetical order
  80.  
  81. Special Features
  82.  
  83. What makes Cinnamon WebMaster Suite useful are the HTML-specific features. Here is an explanation of all current features:
  84.  
  85. Ñ Color-coding
  86.     All text is color-coded for ease of reading. HTML tags are blue, comments are green,
  87.     and all other text is black.
  88. Ñ Automatic Capitalization of tags
  89.     It is customary to type HTML tags in all-caps, but it is very annoying to have to keep
  90.     switching Caps Lock on and off all the time. Go ahead and type tags in lowercase, and
  91.     CWMS will automatically convert each tag to uppercase when you type the ">" at the
  92.     end of the tag. Also, it is smart enough not to convert text which is in quotes.
  93.   New in v1.2: Some common JavaScript keywords are now exempted from auto-caps.
  94.     (See Version History, below) If there are any others you use frequently, let me know.
  95. Ñ ISO-Latin Key Filtering
  96.     CWMS will only allow you to type characters which can be represented in the standard 
  97.     character set of the Internet. (see next item for related info)
  98. Ñ Automatic Special Character Conversion
  99.     In Internet character sets, special characters are represented with embedded
  100.     shortcut values or phrases. For example, "ç" should be entered into a web page using
  101.     "á" or else the incorrect character will be displayed on other computer types.
  102.     CWMS automatically converts special characters to their special codes. Type special
  103.     characters just as you normally would on a Macintosh. If nothing appears, you cannot
  104.     use that particular character on the Internet, although almost all characters can be.
  105. Ñ Smart Entry of Multi-Purpose Characters
  106.     There are several characters which, in addition to being part of regular text, are also
  107.     used within HTML commands. These characters include "<", ">", "&", and """. A simple
  108.     and powerful shortcut has been devised: The first time you type one of these
  109.     characters, it is assumed that you meant to use them for HTML code, and they appear
  110.     like normal. If you instead wanted the character-code to be inserted, all you have to
  111.     do is type the character again! Any time you type one of these characters a second
  112.     time in a row, the first one is automatically removed and replaced with the code!
  113. Ñ Smart Comments maintain compatibility
  114.     The old way of creating a comment was to make a single tag starting with "<!". The
  115.     new method is to use the <COMMENT> and </COMMENT> tags. CWMS supports both
  116.     methods, but you should always use the new method because the old method will not
  117.     be supported in future web browsers, causing your comments to be displayed as part
  118.     of the page. The recommended method is to use both--place the <!--> tag between the
  119.     <COMMENT> and </COMMENT> tags. This way, all browsers will see one or the other.
  120.     If you begin typing an old-style comment, CWMS will assist you by automatically
  121.     converting it to a mixed-style comment. CWMS will not modify new-style comments.
  122.     As of v1.2, "</!" is now a shortcut for "</COMMENT". New in v1.2.1: It is a common
  123.     practice when using JavaScript to 'hide' the code from non-compatible browsers using
  124.     the old "<!" tag without the "<COMMENT>" tag. CWMS will now recognize that you are
  125.     typing an old-style comment after a <SCRIPT> tag and will not insert a <COMMENT>.
  126. Ñ "Insert Color" option
  127.     This shortcut command makes it easy to insert or modify HTML color hex codes. As of
  128.     v1.1.1, in order to further enhance the useability of Insert Color, it has been
  129.     significantly improved. The "#" symbol is now smart, i.e. it will automatically be
  130.     inserted at the beginning of the hex code only if there isn't already one there. Also,
  131.     by double-clicking the hex value of a preexisting color before choosing Insert Color,
  132.     the "old" color in the color picker will be the preexisting color. If no preexisting color
  133.     is selected, the last color that was inserted (into any document) is the default color.
  134. Ñ "Colorize Tags in Selection" option
  135.     This option color-codes all the tags & comments in the selected area of text. Useful
  136.     for updating the colorization of tags which may have been uncolorized during editing.
  137.     The process can be stopped at any time with command-period.
  138.  
  139. How much does Cinnamon WebMaster Suite cost?
  140.  
  141. Previous users of CWMS only: Version 1.2.1 is a complimentary update to anyone who has paid for any previous version. Send in those registrations! Otherwise:
  142.  
  143. Everyone: Cinnamon WebMaster Suite is $5.00 shareware. (Iowa residents $5.25). This program is being distributed on a shareware basis because it isn't ready to be sold commercially, but it's plenty good enough to be quite useful. By registering as a user of Cinnamon WebMaster Suite, you will gain several advantages:
  144.  
  145. Ñ Email notification of new versions or products
  146. Ñ A clear conscience knowing that you're honest
  147. Ñ Free updates between major versions
  148. Ñ I will be encouraged to continue to expand CWMS
  149.  
  150. ***** To register, please print and fill out the registration form found in the same folder as this document, and send it to:
  151.  
  152. Cinnamon Computer Products
  153. Cinnamon Soft Division
  154. 410 W. Meadow Lane
  155. Marshalltown, IA 50158-5113
  156.  
  157. If sending Cash, be sure to use a security envelope, and also wrap the cash inside the registration form. If you live in Iowa, you must add 5% sales tax ($5.25 is the total). If sending check or money order, please make payable to Cinnamon Computer Products.
  158.  
  159. A replacement copy of the Registration Form, as well as the most recent version of CWMS, can be downloaded from the Cinnamon Soft web site at: http://members.aol.com/dustynk/cinnamonsoft/
  160.  
  161. About Cinnamon Computer Products
  162.  
  163. Cinnamon Computer Products is the trade name of Dusty Kothenbeutel, an interactive game and computer professional, and above all a futurist, living in Marshalltown, IA. Cinnamon Computer Products has two divisions:
  164.  
  165. Cinnamon Soft creates useful software for Mac OS-based computers. Cinnamon WebMaster Suite is the trademark product of Cinnamon Soft, which does not officially produce commercial software at this time. Later on, Cinnamon Soft will become a major software developer for multiple platforms.
  166.  
  167. CinnaByte Internet Services provides high-quality Web Site Design, Web Site Hosting, and Internet- and Mac OS-related Consulation. For more information, send email to dustynk@aol.com, or visit http://members.aol.com/dustynk/cinnabyte/, or write to the address above.
  168.  
  169. *** Have you checked out CinnaByte's latest FREE service? It's CinnaByte's MatchSticks Free Online Personals. Go to the CinnaByte web site (http://members.aol.com/dustynk/cinnabyte/) for more info. ***
  170.  
  171. Licensing and Distribution Information
  172.  
  173. This version of Cinnamon WebMaster Suite is shareware, and may be freely distributed across the Internet, online services, and BBSs, as long as the entire software package (the Cinnamon WebMaster Suite application and all accompanying documents, most importantly "Read Me Please!" and "Registration Form", as well as the folder which contains them) is always included and not modified in any way.
  174.  
  175. You are permitted to use this software on a trial basis for a period of up to 30 days, at which time you must send in the completed registration form and $5.00 registration fee (Iowa residents $5.25), or remove the program from your computer. Please send copies of the software package on to everyone you know.
  176.  
  177. The software package may not be included on or in any package or media which is to be sold, or distributed by means other than by modem, without prior written permission (an email response from dustynk@aol.com sufficiently qualifies as written permission) of Cinnamon Soft, with the following exceptions:
  178.  
  179. 1) If you have obtained permission for any previous version of this software package, this permission is hereby extended to this version as well. (I would still appreciate being notified). However, this rule does not apply if you or the party you represent made payment to Cinnamon Computer Products or Dusty Kothenbeutel in order to secure the prior permission.
  180.  
  181. 2) Permission to include this software package is hereby granted to you ahead of time, without a need to contact Cinnamon Computer Products or Dusty Kothenbeutel prior to the release of your package or product, if a complete copy of the entire package or product is sent to Cinnamon Computer Products at the above address, either free of charge, or with a standard single charge of no more than $5.00 US.
  182.  
  183. Contact Cinnamon Soft at the address above for details or to work out an agreement.
  184.  
  185. Future Additions
  186.  
  187. These are just a sampling of features and capabilities which are being planned for addition to future versions of Cinnamon WebMaster Suite:
  188.  
  189. Ñ Totally rewritten in C for speed and capability gains
  190. Ñ Addition of a Preferences file
  191. Ñ Option to deactivate colorization for much faster opening of files
  192.             (it can already be cancelled using command-period)
  193. Ñ Option to capitalize all preexisting tags in a document
  194. Ñ Ability to create plain text documents as well as HTML documents
  195. Ñ Find and Replace
  196. Ñ Menu/Command-key shortcuts for commonly used tags
  197. Ñ FKey shortcuts for commonly used tags
  198. Ñ Print routine
  199. Ñ Ability to Undo
  200. Ñ Shortcut for automatically entering end tags (such as </BODY> or </COMMENT>)
  201. Ñ User-definable shortcuts
  202. Ñ and many more!
  203.  
  204. Compatibility
  205.  
  206. Cinnamon WebMaster Suite has been tested and is thought to be fully-functional under Mac OS System 7 through 8.1. The program is extremely non-volatile, and thus will likely function without problem on System 6, although it hasn't been tested. Regardless of what computer model or system version you have, no guarantees are made that this software will function appropriately or at all. You use this software at your own risk. No responsibility or liability on the part of Cinnamon Computer Products shall exist.
  207.  
  208. If you do have any problems of any sort, please report them to me at dustynk@aol.com, or at the address above. I am very grateful for the reporting of any weaknesses or flaws in this software. Please include a detailed summary including a description of what happened, what you were trying to do, your computer model and configuration, any errors or messages you received, what system software you were using, etc. I may be able to suggest an immediate solution, or work one into the next version.
  209.  
  210. Known Problems & Issues
  211.  
  212. ***** A current listing of known bugs & issues, if any, will be posted on the     *****
  213. ***** Cinnamon Soft site at http://members.aol.com/dustynk/cinnamonsoft/    *****
  214.  
  215. Ñ Several of you have reported a miscolorization bug while typing text immediately after a tag. However, this is not a bug in CWMS. It is an unfortunate side effect which is generated intentionally by the Mac OS. Specifically, the built-in Mac OS text services, known as TextEdit, always apply the same formatting to a typed character as the character immediately before it. This is desirable in nearly all programs, namely word processors. In CWMS, it happens to be a bit undesirable at times. I have worked around it when you are typing text right in a row. But if you use the mouse to place the cursor in a different position, the miscolorization will occur. Unfortunately, there is currently nothing I can do about it because the System does it from beyond CWMS's knowledge or control. I will have resolved the issue by the time version 2.0 is released, because I am writing a custom application environment for the next incarnation of CWMS. In the meantime, this is the reason why I made the "Colorize tags" into a menu option, so that you can clean up the colors any time you want to.
  216. Ñ Choosing Cut, Paste, or Clear from the menu does not register as a change to an unchanged document. FutureBASIC handles the Edit Menu itself and won't allow CWMS to "see" them. (I bet you wouldn't have even noticed this one!) This will be corrected when CWMS is rewritten in C. Workaround 1: Using the command-key shortcuts for Cut or Paste will register as a change. Workaround 2: Make a simple change and undo it.
  217. Ñ Undo is greyed out, because it hasn't been programmed yet
  218. Ñ Preferences is greyed out, because there are no preferences yet
  219.  
  220. Version History
  221.  
  222. Ñ 1.0 - January 30, 1998
  223.     * This is the initial release.
  224. Ñ 1.1 - February 8, 1998
  225.     * Added "Insert Color" feature under Edit Menu
  226.     * Added "</!" as a shortcut for "</COMMENT" as an addition to Smart Comments
  227.     * Corrected a problem where "Save" and "Revert" were not activated/deactivated when switching between documents
  228.     * Corrected a minor colorization problem with one variety of Smart Comments
  229. Ñ 1.1.1 - February 16,1998
  230.     * Windows will now behave properly when resized
  231.     * "Insert Color" now registers as a change to the document
  232.     * "Insert Color" is totally revamped to increase functionality and ease of use:
  233.             * The "#" sign only gets inserted if it's not already there
  234.             * Selecting a preexisting hex color code before choosing Insert Color will use the preexisting color as the default in the color picker
  235.             * If no preexisting hex code is selected, the last color to be inserted is the default
  236.     * The information in the "About Cinnamon Computer Products" window was updated to reflect the address of Cinnamon Soft's new website
  237.     * Added new icons. Big thanks to Eric Ward (ericward@xmission.com), they're great! Note: If the icons don't change, you'll need to rebuild your desktop.
  238. Ñ 1.1.2 - February 26, 1998
  239.     * Added "Colorize Tags in Selection" option under Edit menu. Color-codes all the tags & comments in the selected text, just like it says.  8-)   This is done automatically when a document is first opened, but after editing, there can be tags left uncolored.
  240.     * The Colorization process can now be cancelled at any time during the process. The current incarnation of the Colorize routine is very slow on large files--for example, on my computer it takes over 25 minutes to open this Read Me file. In actuality, it takes less than half a second to load the file, and 25 minutes to colorize it, so I added the command-period abort routine to save time and eliminate hassle. You can always use the new Colorize option on selected parts of the file later.
  241.     * You can now make selections using shift-arrow keys. It has some bugs, but it'll do until I can learn how to implement the Macintosh Drag Manager properly.
  242.     * Removed the ellipsis from the "New" option under the File menu. Once I implement some other file types, it will return and be proper. (Thanks to Scott Knick for noticing that one)
  243. Ñ 1.1.3 - March 2, 1998
  244.     * Corrected a bug where a '!' anywhere in a tag would cause it to be comment-colored instead of tag-colored (reported by Scott Knick)
  245.     * Corrected a bug where typing a '!' did not register as a change to the document
  246.     * Includes several new files: An AutoTyper to convert TEXT files to have a CWMS creator type, and a small icon to be included on web pages created with CWMS with a link back to the Cinnamon Soft website.
  247. Ñ 1.2 - March 17, 1998
  248.     * The following JavaScript keywords are now exempted from Auto-capitalization for aesthetic reasons: onClick, onFocus, onBlur, onChange, onMouseOver, onMouseOut, onSelect, onSubmit, onReset
  249.     * Added an Insert Date option under the Edit menu
  250.     * Added an Insert Time option under the Edit menu
  251.     * Added a new "Made with CWMS" graphic, courtesy of Oliver Mandic
  252. Ñ 1.2.1 - April 7, 1998
  253.     * Smart Comments have gained another IQ point. It is common for JavaScript users to use an old-style comment (<!-- -->) around the code to hide it from non-Java-capable browsers. Smart Comments will now differentiate between a regular comment and one following a <SCRIPT> tag, and will not convert the old-style tag into a new-style one. (Thanks to Scott Knick for reporting the problem)
  254.     * Fixed a small bug with the Colorize tags option, which failed to colorize plain text
  255.  
  256. BugZappers Hall of Fame
  257.  
  258. Here's your chance to live forever! Send in a bug report, and get your name in the Hall of Fame! Only new and unknown bugs count.
  259.  
  260.     1) Scott Knick - 3 bugs
  261.  
  262. Legal Information
  263.  
  264. All products, names, and companies mentioned in this document are the trademarks, registered trademarks, or other property of their respective companies.
  265.  
  266. ⌐1998 Cinnamon Computer Products. All Rights Reserved.
  267.